Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Automate the since updater #7240

Merged
merged 3 commits into from
Sep 12, 2024
Merged

Automate the since updater #7240

merged 3 commits into from
Sep 12, 2024
+53 −4

Conversation

NotMyFault
Copy link
Member

@NotMyFault NotMyFault commented Oct 9, 2022 •
edited by timja
Loading

The change proposed aims to automate the process of filling in since annotations to make PRs like #7239 redundant.

Testing done

A PoC is available at timja#137

Proposed changelog entries

  • Entry 1: Issue, human-readable text
  • […]

Proposed upgrade guidelines

N/A

Submitter checklist

  • The Jira issue, if it exists, is well-described.
  • The changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developers, depending on the change) and are in the imperative mood (see examples).
    • Fill in the Proposed upgrade guidelines section only if there are breaking changes or changes that may require extra steps from users during upgrade.
  • There is automated testing or an explanation as to why this change has no tests.
  • New public classes, fields, and methods are annotated with @Restricted or have @since TODO Javadocs, as appropriate.
  • New deprecations are annotated with @Deprecated(since = "TODO") or @Deprecated(forRemoval = true, since = "TODO"), if applicable.
  • New or substantially changed JavaScript is not defined inline and does not call eval to ease future introduction of Content Security Policy (CSP) directives (see documentation).
  • For dependency updates, there are links to external changelogs and, if possible, full differentials.
  • For new APIs and extension points, there is a link to at least one consumer.

Desired reviewers

@mention

Maintainer checklist

Before the changes are marked as ready-for-merge:

  • There are at least two (2) approvals for the pull request and no outstanding requests for change.
  • Conversations in the pull request are over, or it is explicit that a reviewer is not blocking the change.
  • Changelog entries in the pull request title and/or Proposed changelog entries are accurate, human-readable, and in the imperative mood.
  • Proper changelog labels are set so that the changelog can be generated automatically.
  • If the change needs additional upgrade steps from users, the upgrade-guide-needed label is set and there is a Proposed upgrade guidelines section in the pull request title (see example).
  • If it would make sense to backport the change to LTS, a Jira issue must exist, be a Bug or Improvement, and be labeled as lts-candidate to be considered (see query).

@NotMyFault NotMyFault added the skip-changelog Should not be shown in the changelog label Oct 9, 2022
@daniel-beck
Copy link
Member

daniel-beck commented Oct 10, 2022 •
edited
Loading

The linked PR has messed up formatting, it should be a nested list. Additionally, the first output (before "List of commits") probably shouldn't be in the PR (or in a disclosure block, HTML comment, or similarly hidden except when debugging).

@NotMyFault
Copy link
Member Author

The linked PR has messed up formatting, it should be a nested list

According to the GH forums, the best you can do to preserve a bit of formatting is
https://github.com/jenkinsci/jenkins/pull/7240/files#diff-a5957abd073e9c3e3e614f9bf230c7779a16f3daba698c896f6756b7cb7d8f3eR21-R23

:/

probably shouldn't be in the PR

Which part do you mean in particular?

@lemeurherve
Copy link
Member

According to the GH forums

Got a link?

@lemeurherve
Copy link
Member

Note: updatecli can run scripts too, maybe another way to preserve formatting.

@NotMyFault
Copy link
Member Author

According to the GH forums

Got a link?

https://github.com/peter-evans/create-pull-request/blob/main/docs/examples.md#setting-the-pull-request-body-from-a-file

@daniel-beck
Copy link
Member

Which part do you mean in particular?

Everything above the quoted string is debug output generated immediately. If the script aborts, it helps determining where it failed. Everything starting from the quoted string is output intended for convenient PR use.

timja
timja approved these changes Oct 15, 2022
View reviewed changes
Copy link
Member

@timja timja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

worth a go, looks nice!

@timja
Copy link
Member

timja commented Sep 10, 2024

Multiline strings are now documented at https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#example-of-a-multiline-string

Not super clean but it works and is nicer than before.

But GitHub PR descriptions don't handle tab characters so I've turned it into a markdown list instead

@daniel-beck any thoughts now? see timja#137

@timja timja requested a review from a team September 10, 2024 21:37
@daniel-beck
Copy link
Member

@timja "List of commits" looks good now 👍 Could you wrap the "Analyzing" bits in a <details> block as suggested in #7240 (comment)? Since this is just debug output I doubt we need to always see it.

@timja
Copy link
Member

timja commented Sep 11, 2024

@timja "List of commits" looks good now 👍 Could you wrap the "Analyzing" bits in a <details> block as suggested in #7240 (comment)? Since this is just debug output I doubt we need to always see it.

If I understood you right that's been done, see timja#137

@timja timja merged commit 36c155e into jenkinsci:master Sep 12, 2024
16 checks passed
janfaracik added a commit to janfaracik/jenkins that referenced this pull request Sep 12, 2024
@janfaracik
Squashed commit of the following:
8223179 
commit c5128f4
Author: Jan Faracik <[email protected]>
Date:   Thu Sep 12 14:39:02 2024 +0100

    Use notice for views lacking jobs

commit bb7a30a
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Thu Sep 12 09:02:10 2024 +0100

    Update dependency org.jenkins-ci.plugins:script-security to v1361 (jenkinsci#9719)

    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

commit 5fc92c6
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Thu Sep 12 09:01:59 2024 +0100

    Update jenkins/ath Docker tag to v5992 (jenkinsci#9720)

    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

commit 36c155e
Author: Alexander Brandes <[email protected]>
Date:   Thu Sep 12 10:01:35 2024 +0200

    Automate the since updater (jenkinsci#7240)

    Co-authored-by: Tim Jacomb <[email protected]>

commit 65f374c
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Wed Sep 11 05:13:32 2024 -0600

    Update dependency org.jenkins-ci.plugins:junit to v1300 (jenkinsci#9716)

    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

commit 35d7677
Author: Vincent Latombe <[email protected]>
Date:   Wed Sep 11 04:32:36 2024 +0200

    Introduce `HistoricalBuild` interface (jenkinsci#9674)

    * Introduce HistoricalBuild interface

    This allows to display Run-like objects in build history without having concrete Run present in the Jenkins instance.

    * Remove BuildHistoryWidget#entries.jelly

    * JDK17 level

    Co-authored-by: Jesse Glick <[email protected]>

    ---------

    Co-authored-by: Jesse Glick <[email protected]>

commit 78e132d
Author: Basil Crow <[email protected]>
Date:   Tue Sep 10 19:32:04 2024 -0700

    Build tests without forking the compiler (jenkinsci#9717)

commit 66a7810
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Tue Sep 10 20:31:40 2024 -0600

    Update dependency org.jenkins-ci.plugins:cloudbees-folder to v6.951.v5f91d88d76b_b_ (jenkinsci#9715)

    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

commit 53f3203
Author: Daniel Beck <[email protected]>
Date:   Tue Sep 10 22:52:20 2024 +0200

    [JENKINS-73709] Build without forking the compiler (jenkinsci#9709)

    Co-authored-by: Daniel Beck <[email protected]>

commit 905df3d
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Tue Sep 10 09:40:46 2024 -0700

    Update dependency org.jenkins-ci.plugins:junit to v1299 (jenkinsci#9714)

    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

commit 11c405b
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Tue Sep 10 09:40:08 2024 -0700

    Update dependency org.apache.maven.plugins:maven-jarsigner-plugin to v3.1.0 (jenkinsci#9712)

    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

commit eb6be17
Author: Jenkins Release Bot <[email protected]>
Date:   Tue Sep 10 14:10:20 2024 +0000

    [maven-release-plugin] prepare for next development iteration

commit 561231f
Author: Jenkins Release Bot <[email protected]>
Date:   Tue Sep 10 14:09:56 2024 +0000

    [maven-release-plugin] prepare release jenkins-2.476

commit 0c49380
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Mon Sep 9 16:47:09 2024 -0700

    Update eslint monorepo to v9.10.0 (jenkinsci#9710)

    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

commit 1b8c198
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Mon Sep 9 11:19:46 2024 -0700

    Update dependency io.jenkins.plugins:font-awesome-api to v6.6.0-2 (jenkinsci#9708)

    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

commit 85d6358
Author: Basil Crow <[email protected]>
Date:   Mon Sep 9 08:14:48 2024 -0700

    Compatibility for `ChainedServletFilter` (jenkinsci#9696)

commit 4334aa0
Author: Juan Jesús Alejo Sillero <[email protected]>
Date:   Mon Sep 9 17:13:51 2024 +0200

    fix(i18n): correct typo in Spanish translation for 'Preparation' (jenkinsci#9702)

commit 2431b7c
Author: Markus Winter <[email protected]>
Date:   Mon Sep 9 17:13:20 2024 +0200

    [JENKINS-72988] validate displayname against items in the same ItemGroup (jenkinsci#9152)

    Co-authored-by: Kris Stern <[email protected]>

commit bfcb874
Merge: b56e5d7 2f6d77c
Author: Vincent Latombe <[email protected]>
Date:   Mon Sep 9 16:57:03 2024 +0200

    Merge pull request jenkinsci#9645 from Vlatombe/with-console-url

commit b56e5d7
Merge: c05d756 6b88bfc
Author: Vincent Latombe <[email protected]>
Date:   Mon Sep 9 11:21:50 2024 +0200

    Merge pull request jenkinsci#9673 from Vlatombe/computerListener.onIdle

commit 2f6d77c
Merge: 49618a0 307f680
Author: Vincent Latombe <[email protected]>
Date:   Wed Sep 4 10:48:53 2024 +0200

    Merge branch 'master' into with-console-url

commit 6b88bfc
Author: Vincent Latombe <[email protected]>
Date:   Wed Aug 28 16:22:14 2024 +0200

    Spotless

commit ed93ad0
Author: Vincent Latombe <[email protected]>
Date:   Wed Aug 28 16:12:09 2024 +0200

    Revert "Call listener synchronously, but outside synchronized"

    This reverts commit 75242cf.

commit 75242cf
Author: Vincent Latombe <[email protected]>
Date:   Wed Aug 28 15:47:51 2024 +0200

    Call listener synchronously, but outside synchronized

commit 9823b8e
Author: Vincent Latombe <[email protected]>
Date:   Wed Aug 28 15:40:43 2024 +0200

    Execute ComputerListener#onIdle in another thread.

commit 64667af
Author: Vincent Latombe <[email protected]>
Date:   Wed Aug 28 09:54:25 2024 +0200

    Implement ComputerListener#onIdle

    Introduces a new computer listener fired whenever a Computer becomes idle.

commit 49618a0
Author: Vincent Latombe <[email protected]>
Date:   Fri Aug 23 08:14:22 2024 +0200

    Updating the test to note the behavioural change

commit 2d30cfc
Author: Vincent Latombe <[email protected]>
Date:   Thu Aug 22 17:20:38 2024 +0200

    Fix review

commit 44602bb
Author: Vincent Latombe <[email protected]>
Date:   Thu Aug 22 17:12:59 2024 +0200

    Typo spotted by @dwnusbaum

    Co-authored-by: Devin Nusbaum <[email protected]>

commit 39d30c8
Author: Vincent Latombe <[email protected]>
Date:   Tue Aug 13 15:04:12 2024 +0200

    Add WithConsoleUrl interface

    This simplifies the logic of `Functions#getConsoleUrl` and makes it pluggable.
@basil basil mentioned this pull request Sep 19, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timja timja timja approved these changes

@daniel-beck daniel-beck daniel-beck approved these changes

Assignees
No one assigned
Labels
skip-changelog Should not be shown in the changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@NotMyFault @daniel-beck @lemeurherve @timja